Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ticket14 docs webpage #31

Merged
merged 25 commits into from
Sep 30, 2024
Merged

Ticket14 docs webpage #31

merged 25 commits into from
Sep 30, 2024

Conversation

rerpha
Copy link
Contributor

@rerpha rerpha commented Sep 24, 2024

Closes #14

unfortunately this won't publish to pages until it's merged as it uses https://github.com/ISISComputingGroup/reusable-workflows/blob/main/.github/workflows/sphinx.yml which is pinned to only publish on main, but you can build the sphinx docs locally (see the page in doc\dev\set_up_dev_environment.md) and check they look OK as a reviewer.

I played around with this and an old version of the docs has been published to https://isiscomputinggroup.github.io/ibex_bluesky_core/ as a proof of concept. the github workflow will run when merged and update (though give it a few minutes as it takes a while to publish to the webpage)

What this means for WIP/unreviewed branches:

  • see how doc/ folder structure has changed and adjust accordingly
  • docstring inline code examples will need to change, see this PR's sphinx tips page in doc/

@pull-request-size pull-request-size bot added size/L and removed size/M labels Sep 24, 2024
Update link to Admonition
@davidkeymer davidkeymer merged commit f358372 into main Sep 30, 2024
11 checks passed
@davidkeymer davidkeymer deleted the ticket14_docs_webpage branch September 30, 2024 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Render documentation to web pages
3 participants